Get a User by UserName
{ getUsersByName }
Returns a list of users based on search criteria
Method
/API3/access/getUsersByName
- Enterprise Admin
Input Parameters
Name
searchCriteria
Object Type
Description
The search criteria for finding materialized data elements.
Output Response
Successful Result Code
200
Response List Type
Description of Response Type
User response object with details of the user found in the system.. Note that the response is returned as a list of items of this object type.
Notes
The user object can be used in other operations where it is required, the returned user object does not contain user roles use getUser API to get full data.
Examples
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
TypeScript
Curl
Java
C#
Python
PHP